Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: Add examples for API #113

Merged
merged 13 commits into from
Dec 16, 2024
Merged

chore: Add examples for API #113

merged 13 commits into from
Dec 16, 2024

Conversation

vrongmeal
Copy link
Member

@vrongmeal vrongmeal commented Dec 13, 2024 •
edited
Loading

These are the examples I am thinking of having for the API docs:

  • Create basin and get basin config
  • Reconfigure basin
  • Delete basin
  • List all basins: Fetch all basins taking has_more in consideration.
  • Create stream and get stream config
  • Reconfigure stream
  • Delete stream
  • List streams with prefix
  • Explicit trim: Delete data till latest sequence number
  • Producer (with Fencing token)
  • Get latest record
  • Consumer

@vrongmeal
chore: Add examples for API
b82017a 
Signed-off-by: Vaibhav Rabber <[email protected]>
@vrongmeal vrongmeal requested a review from a team as a code owner December 13, 2024 15:35
infiniteregrets
infiniteregrets reviewed Dec 13, 2024
View reviewed changes
Copy link
Member

@infiniteregrets infiniteregrets left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you give rustdoc-scrape-examples a try here?

@infiniteregrets
Copy link
Member

https://doc.rust-lang.org/rustdoc/scraped-examples.html

@vrongmeal
create basin
1ea6184 
Signed-off-by: Vaibhav Rabber <[email protected]>
@vrongmeal
list all basins
bc350ea 
Signed-off-by: Vaibhav Rabber <[email protected]>
@vrongmeal
create stream
f0a9959 
Signed-off-by: Vaibhav Rabber <[email protected]>
@vrongmeal
Merge remote-tracking branch 'origin/main' into vrongmeal/examples
9e51189
@vrongmeal
reconfigure stream
187f524 
Signed-off-by: Vaibhav Rabber <[email protected]>
@vrongmeal
explicit trim
d14a1d7 
Signed-off-by: Vaibhav Rabber <[email protected]>
@vrongmeal
doc scrape examples
1a4f18f 
Signed-off-by: Vaibhav Rabber <[email protected]>
@vrongmeal
more examples
4143293 
Signed-off-by: Vaibhav Rabber <[email protected]>
@vrongmeal
fix list all basins
60a27ef 
Signed-off-by: Vaibhav Rabber <[email protected]>
@vrongmeal
reads...
66d3c32 
Signed-off-by: Vaibhav Rabber <[email protected]>
@vrongmeal
producer
35be7fc 
Signed-off-by: Vaibhav Rabber <[email protected]>
shikhar
shikhar approved these changes Dec 16, 2024
View reviewed changes
Copy link
Member

@shikhar shikhar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice, thank you!

@vrongmeal
fix
d4bd446 
Signed-off-by: Vaibhav Rabber <[email protected]>
@vrongmeal vrongmeal merged commit 723dfcd into main Dec 16, 2024
3 checks passed
@vrongmeal vrongmeal deleted the vrongmeal/examples branch December 16, 2024 12:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@infiniteregrets infiniteregrets infiniteregrets left review comments

@shikhar shikhar shikhar approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@vrongmeal @infiniteregrets @shikhar